Skip to content

fix: update the Kinde environments page#739

Open
tamalchowdhury wants to merge 6 commits into
mainfrom
tamal/update/kinde-environments-update
Open

fix: update the Kinde environments page#739
tamalchowdhury wants to merge 6 commits into
mainfrom
tamal/update/kinde-environments-update

Conversation

@tamalchowdhury

@tamalchowdhury tamalchowdhury commented May 26, 2026

Copy link
Copy Markdown
Collaborator

This PR updates the environment page of the docs with updated steps and info.

Summary by CodeRabbit

  • Documentation
    • Reorganized "Manage Kinde environments" with expanded workflows for creating/renaming/deleting non-production environments, environment switching, updated FAQs (notes on config copying and API option), and refreshed page metadata/summaries.
    • Revised production-to-live guide with clearer go-live steps, required third-party credential and SMS setup, recommended security/delivery best practices, and clearer switch-to-live instructions and error guidance.
    • Standardized "Environment details" capitalization across several integration and tracking guides and adjusted a testing doc link.

@tamalchowdhury tamalchowdhury requested a review from a team as a code owner May 26, 2026 18:27
@coderabbitai

coderabbitai Bot commented May 26, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: c807f236-3920-4742-9a50-5835d5a66996

📥 Commits

Reviewing files that changed from the base of the PR and between b7e91d5 and 5088b8f.

📒 Files selected for processing (7)
  • src/content/docs/build/environments/environments.mdx
  • src/content/docs/build/environments/production-to-live.mdx
  • src/content/docs/manage-users/view-activity/contentsquare.mdx
  • src/content/docs/manage-users/view-activity/hotjar.mdx
  • src/content/docs/manage-users/view-activity/third-party-tracking.mdx
  • src/content/docs/manage-users/view-activity/track-user-sign-in-with-google-analytics.mdx
  • src/content/docs/workflows/testing/index.mdx
✅ Files skipped from review due to trivial changes (5)
  • src/content/docs/workflows/testing/index.mdx
  • src/content/docs/manage-users/view-activity/contentsquare.mdx
  • src/content/docs/manage-users/view-activity/hotjar.mdx
  • src/content/docs/manage-users/view-activity/third-party-tracking.mdx
  • src/content/docs/manage-users/view-activity/track-user-sign-in-with-google-analytics.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/content/docs/build/environments/production-to-live.mdx

Walkthrough

Two documentation pages covering Kinde environment management were restructured. The environments overview page was reorganized around practical workflows for managing environments and a new FAQ addressing configuration-copying constraints. The production go-live checklist was rewritten with clearer separation of required versus recommended setup steps and expanded subsections for each configuration area.

Changes

Manage Kinde Environments Documentation

Layer / File(s) Summary
Page metadata and frontmatter
src/content/docs/build/environments/environments.mdx
Page title changed to "Manage Kinde environments"; description, sidebar label, table-of-contents configuration, keywords, updated date, and ai_summary were refreshed to reflect the new documentation structure.
Body content and workflows
src/content/docs/build/environments/environments.mdx
Introduction reorganized with environments-at-a-glance rules and checklist reference. Main sections now cover the environment switcher, detailed workflows for creating/renaming/deleting non-production environments, environment settings updates, and a new FAQ addressing configuration copying limitations and the Management API alternative.
Cross-site casing and links
src/content/docs/manage-users/view-activity/contentsquare.mdx, src/content/docs/manage-users/view-activity/hotjar.mdx, src/content/docs/manage-users/view-activity/third-party-tracking.mdx, src/content/docs/manage-users/view-activity/track-user-sign-in-with-google-analytics.mdx, src/content/docs/workflows/testing/index.mdx
Standardized "Environment details" capitalization across integration/tracking guides and updated a "Use environments" link to the non-fragment URL.

Production Go-Live Checklist Restructure

Layer / File(s) Summary
Page metadata and frontmatter
src/content/docs/build/environments/production-to-live.mdx
Page description, sidebar label, topics list (expanded to include "security"), table-of-contents heading depth, ai_summary, and updated date were refreshed to align with the reorganized checklist.
Required setup steps
src/content/docs/build/environments/production-to-live.mdx
Introduction and "Required steps to go live" section updated with explicit third-party credential setup guidance and warnings about leaving credential fields blank. Dedicated "Add Twilio details" subsection added with specific UI paths and save instructions for SMS/phone authentication.
Recommended steps and finalization
src/content/docs/build/environments/production-to-live.mdx
"Recommended steps" reorganized into detailed subsections covering terms/privacy URLs, multi-factor authentication, default roles, custom domain, custom email sender, tracking scripts, and development environment setup. Final "Switch production environment to appear live" instructions rewritten as a numbered flow with updated navigation paths and clarified success/error messaging.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested labels

Update doc

Suggested reviewers

  • onderay

Poem

🐰 Two docs now dance with clearer grace,
Environments and go-live find their place,
With FAQs and steps all neatly laid,
The path to production is no longer frayed!
Workflows bloom where workflows belong.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'fix: update the Kinde environments page' clearly summarizes the main change: updating the environments documentation page with refreshed content, structure, and metadata.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch tamal/update/kinde-environments-update

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented May 26, 2026

Copy link
Copy Markdown

Deploying kinde-docs-preview with  Cloudflare Pages  Cloudflare Pages

Latest commit: 5088b8f
Status: ✅  Deploy successful!
Preview URL: https://323c64e8.kinde-docs-preview.pages.dev
Branch Preview URL: https://tamal-update-kinde-environme.kinde-docs-preview.pages.dev

View logs

@tamalchowdhury tamalchowdhury changed the title 🚧 Work in Progress: update the Kinde environments page fix: update the Kinde environments page May 27, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/content/docs/build/environments/environments.mdx`:
- Line 74: The sentence uses the plural "environments" incorrectly; update the
text in src/content/docs/build/environments/environments.mdx by replacing "You
will need a [paid plan](https://kinde.com/pricing/) to create more than one
non-production environments." with the corrected wording using the singular
"environment" (e.g., "You will need a [paid plan](https://kinde.com/pricing/) to
create more than one non-production environment.").

In `@src/content/docs/build/environments/production-to-live.mdx`:
- Line 106: Update the MFA toggle wording in
src/content/docs/build/environments/production-to-live.mdx around the line
containing "Toggle the switch to either **Yes** or **Optional**" to also mention
the "No" option (e.g., "Toggle the switch to **Yes**, **Optional**, or **No**")
or add a short clarifying sentence that this step only covers enabling MFA and
that "No" disables the environment-level MFA requirement; ensure the change
replaces or augments the existing phrase so readers see all three options.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: cd91c4e7-9341-4750-b160-c32f36df6037

📥 Commits

Reviewing files that changed from the base of the PR and between b3f604c and 66d97a2.

📒 Files selected for processing (2)
  • src/content/docs/build/environments/environments.mdx
  • src/content/docs/build/environments/production-to-live.mdx

Comment thread src/content/docs/build/environments/environments.mdx Outdated
Comment thread src/content/docs/build/environments/production-to-live.mdx Outdated
Comment thread src/content/docs/build/environments/environments.mdx Outdated
Comment thread src/content/docs/build/environments/production-to-live.mdx
@onderay

onderay commented Jun 10, 2026

Copy link
Copy Markdown
Member

@tamalchowdhury

Add paid-plan note for analytics

Both pages describe adding Google Analytics, Hotjar, and Contentsquare without noting they require a paid plan. Third-party tracking opens with an <Aside type="upgrade"> for this.

Please add the same aside (or equivalent inline note) in:

  • ### Update environment settings on environments.mdx
  • ### Add tracking scripts on production-to-live.mdx

Fix broken cross-doc anchor

workflows/testing/index.mdx links to /build/environments/environments/#add-an-environment, but the heading is now ### Create a new environment (anchor #create-a-new-environment). Please update that link in this PR or as an immediate follow-up.

Should fix (nice to have in this PR)

  • Bold All environments in the go-live “Add a development environment” steps for consistency with environments.mdx
  • Consider adding relatedArticles on environments.mdx (e.g. go-live checklist, manage-kinde-configuration, store-environment-variables)
  • Align menu path casing (Environment details vs Details vs Environment Details) with sibling docs like third-party tracking

@tamalchowdhury tamalchowdhury left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all requests implemented

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants